Click input manipulator recognizes the click and tap gestures from the incoming touch events. More...
#include <kanzi/core.ui/input/click_manipulator.hpp>
Classes | |
class | ClickBeginMessageArguments |
Message arguments for click gesture began message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | ClickCancelMessageArguments |
Message arguments for click canceled message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | ClickEnterMessageArguments |
Message arguments for pointer entering the node area message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | ClickLeaveMessageArguments |
Message arguments for pointer leaving the node area message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | ClickMessageArguments |
Message arguments for click gesture recognized message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
Public Member Functions | |
bool | isPressed () const |
Returns true if manipulator is in the pressed state. | |
void | setHoverToBegin (bool hoverToBegin) |
Enable or disable the gesture to begin on pressed touch point arriving to the node area. | |
Public Member Functions inherited from kanzi::InputManipulator | |
void | attach (Node &node) |
Attaches an input manipulator to a node. | |
void | cancel () |
Notify manipulator of touch canceling. | |
void | detach () |
Detaches an input manipulator. | |
Node * | getAttachedNode () const |
Gets the node to which the input manipulator is attached. | |
InputManipulator * | getDependantManipulator () const |
Gets the dependant input manipulator. | |
EventRoutingMode | getEventRoutingMode () |
Returns the current input event routing mode. | |
InputManipulatorWeakPtr | getFailManipulator () const |
Gets the fail manipulator. | |
State | getState () const |
Get the state of an input manipulator. | |
KZ_DEPRECATED TouchEventRoutingMode | getTouchEventRoutingMode () |
Returns the current touch event routing mode. | |
ManipulatorType | getType () const |
Returns the type of the input manipulator. | |
bool | isActive () const |
Checks whether an input manipulator is in active state. | |
bool | isAttached () const |
Tells whether the input manipulator is attached to a node. | |
bool | isCancelable () const |
Returns whether an input manipulator is in a cancelable state. | |
bool | isResettable () const |
Returns whether an input manipulator is in a resettable state. | |
void | requireToFail (InputManipulatorWeakPtr manipulatorToFail) |
Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. | |
void | reset () |
Reset the manipulator. | |
void | setEventRoutingMode (EventRoutingMode mode) |
Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators. | |
void | setReferenceNode (NodeWeakPtr referenceNode) |
Override the attached node as the hit test reference node. | |
void | setState (State state) |
Set the state of an input manipulator. | |
KZ_DEPRECATED void | setTouchEventRoutingMode (TouchEventRoutingMode mode) |
Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators. | |
~InputManipulator () override | |
Destructor. | |
Public Member Functions inherited from kanzi::Object | |
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. | |
void | applyObjectStyles () |
Apply all styles for an object node. | |
Domain * | getDomain () const |
Returns the domain the object belongs to. | |
const Metaclass * | getDynamicMetaclass () const override |
Returns the metaclass of the dynamic type of the object. | |
MainLoopScheduler * | getMainLoopScheduler () const |
Returns the MainLoopScheduler instance of the associated Domain. | |
detail::MessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. | |
ScriptingContextSharedPtr | getScriptingContext () const |
Gets the scripting context of the object. | |
Object (Domain *domain) | |
void | setScriptingContext (ScriptingContextSharedPtr context) |
Sets the scripting context of the object. | |
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. | |
~Object () override | |
Public Member Functions inherited from kanzi::MetaObject | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. | |
virtual | ~MetaObject () |
Public Member Functions inherited from kanzi::PropertyObject | |
template<typename DataType > | |
void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
template<typename DataType > | |
void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
Adds a property modifier without notifying handlers. | |
template<typename DataType > | |
void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
PropertyStorageContainer::iterator | beginPropertyStorage () |
Returns the begin iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
Returns the begin iterator to the internal property storage container. | |
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
Copies local value of single property from another object. | |
void | copyLocalValues (const PropertyObject &other) |
Copies all local values from another object. | |
PropertyStorageContainer::iterator | endPropertyStorage () |
Returns the end iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | endPropertyStorage () const |
Returns the end iterator to the internal property storage container. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property type. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers. | |
template<typename DataType > | |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
Gets number of current notification handlers for given property type. | |
bool | hasBaseValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. | |
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. | |
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
Virtual function to handle property change notifications. | |
PropertyObject () | |
void | removeKzbProperties () |
Remove all KZB properties. | |
void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
Remove all KZB properties that are not included in a given set. | |
template<typename DataType > | |
void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. | |
template<typename DataType > | |
void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
template<typename DataType > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
Sets the local value of a property type. | |
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
virtual | ~PropertyObject () |
Static Public Member Functions | |
static ClickManipulatorSharedPtr | create (Domain *domain, string_view="") |
Static Public Member Functions inherited from kanzi::Object | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Static Public Member Functions inherited from kanzi::MetaObject | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Static Public Attributes | |
static MessageType< ClickBeginMessageArguments > | ClickBeginMessage |
Message type that you can use to notify the beginning of a click gesture. | |
static MessageType< ClickCancelMessageArguments > | ClickCancelMessage |
Message type for notifying cancellation of click gesture. | |
static MessageType< ClickEnterMessageArguments > | ClickEnterMessage |
Message type for notifying the tracked touch entering the node area. | |
static MessageType< ClickLeaveMessageArguments > | ClickLeaveMessage |
Message type for notifying the tracked touch leaving the node area. | |
static MessageType< ClickMessageArguments > | ClickMessage |
Message type for notifying recognition of click gesture. | |
Additional Inherited Members | |
Public Types inherited from kanzi::InputManipulator | |
enum | EventRoutingMode { RoutingBubbling , RoutingTunneling } |
Enumeration for the available input event routing modes. More... | |
enum class | ManipulatorType { TouchInputHandler , KeyInputHandler } |
Enumeration for the input manipulator type. More... | |
enum | State { StateReady , StatePossible , StateBegin , StateChange , StateEnd , StateFail , StateDelayed , StateCanceled } |
Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More... | |
using | TouchEventRoutingMode |
Enumeration for the available touch event routing modes. | |
using | TouchPointsConstIterator |
using | TouchPointsContainer |
Public Types inherited from kanzi::PropertyObject | |
typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
Protected Types inherited from kanzi::Object | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. | |
Static Protected Member Functions inherited from kanzi::InputManipulator | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. | |
Click input manipulator recognizes the click and tap gestures from the incoming touch events.
The click manipulator generates the messages required to implement the logic for UI elements that users can click or tap. For example, use the input manipulator to create a button.
To receive the click event, add a message handler for the ClickMessage message.
First create a handler method:
Then add a message handler for your node:
To configure the click manipulator to work together with the multi-click manipulator, you need to configure the click manipulator to wait for the failure of the multi-click:
|
explicitprotected |
Constructor.
|
inlinestatic |
Enable or disable the gesture to begin on pressed touch point arriving to the node area.
bool kanzi::ClickManipulator::isPressed | ( | ) | const |
Returns true if manipulator is in the pressed state.
|
overrideprotectedvirtual |
InputManipulator::notifyTouchInside implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::notifyTouchOutside implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::onReset implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::onCancel implemenation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::onFail implementation.
Reimplemented from kanzi::InputManipulator.
|
static |
Message type for notifying recognition of click gesture.
Kanzi generates a click message when the user releases a tracked touch over an attached node, or when the fail manipulator fails.
|
static |
Message type that you can use to notify the beginning of a click gesture.
Kanzi generates the ClickBeginMessage in these cases:
|
static |
Message type for notifying cancellation of click gesture.
Click gesture is canceled when the tracked touch is released outside the node area, or when the fail manipulator succeeds (see InputManipulator::requireToFail).
|
static |
Message type for notifying the tracked touch entering the node area.
Click enter message is generated when touch is pressed over the node area or when the touch returns to the node area after leaving it.
|
static |
Message type for notifying the tracked touch leaving the node area.
Click leave message is generated when the pointer leaves the area or when the click gesture is completed or canceled.